| Description | : Given a request with a user’s location and a partial query that serves as the prefix of a full query string (referred to as a query prefix), the Azure Maps Autocomplete API returns a list of suggested entities that the user is most likely searching for. These entities are ranked from most to least likely. |
| Reference | : Link ¶ |
⚶ Changes
{
"#id": "Search_GetGeocodeAutocomplete",
"Description": {
"new": "\n\nGiven a request with a user\u2019s location and a partial query that serves as the prefix of a full query string (referred to as a query prefix), the Azure Maps Autocomplete API returns a list of suggested entities that the user is most likely searching for. These entities are ranked from most to least likely.\n\n",
"old": "**Autocomplete API**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nGiven a request with a user\u2019s location and a partial query that serves as the prefix of a full query string (referred to as a query prefix), the Azure Maps Autocomplete API returns a list of suggested entities that the user is most likely searching for. These entities are ranked from most to least likely.\n\n"
},
"$parameters": [
{
"#name": "resultTypes",
"Description": {
"new": "A comma separated list of returned entity types.\nWhen type group is set to Address, the supported types are:\n\n- Address\n- RoadBlock\n\nAll other types belong to the Place type group. These may include entities such as AdminDivision1, Neighborhood, PopulatedPlace, and more.\nDefault value is all possible entity types.",
"old": "A comma separated list of returned entity types.\nWhen type group is set to Address, the supported types are:\n\n- Address\n- RoadBlock\n- RoadIntersection\n\nAll other types belong to the Place type group. These may include entities such as AdminDivision1, Neighborhood, PopulatedPlace, and more.\nDefault value is all possible entity types."
}
}
],
"$responses": {
"200": {
"$properties": {
"features": {
"$properties": {
"properties": [
{
"#name": "typeGroup",
"Enum": {
"new": [
[
"Address",
"A specific address location. Supported types are: \n\n- Address\n- RoadBlock\n\n"
],
[
"Place",
"All other types belong to the Place type group. These may include entities such as AdminDivision1, Neighborhood, PopulatedPlace, and more."
]
],
"old": [
[
"Address",
"A specific address location. Supported types are: \n\n- Address\n- RoadIntersection\n- RoadBlock\n\n"
],
[
"Place",
"All other types belong to the Place type group. These may include entities such as AdminDivision1, Neighborhood, PopulatedPlace, and more."
]
]
}
},
{
"#name": "type",
"Enum": {
"new": [
[
"Address",
""
],
[
"AdminDivision1",
""
],
[
"AdminDivision2",
""
],
[
"AdminDivision3",
""
],
[
"AdministrativeBuilding",
""
],
[
"Airport",
""
],
[
"AirportTerminal",
""
],
[
"AmusementPark",
""
],
[
"AncientSite",
""
],
[
"Aquarium",
""
],
[
"Archipelago",
""
],
[
"Basin",
""
],
[
"Battlefield",
""
],
[
"Bay",
""
],
[
"Beach",
""
],
[
"Bridge",
""
],
[
"BusinessStructure",
""
],
[
"Camp",
""
],
[
"Canal",
""
],
[
"Casino",
""
],
[
"Castle",
""
],
[
"Cave",
""
],
[
"Cemetery",
""
],
[
"Channel",
""
],
[
"Church",
""
],
[
"Cliff",
""
],
[
"Coast",
""
],
[
"CommunityCenter",
""
],
[
"Continent",
""
],
[
"CountryRegion",
""
],
[
"Crater",
""
],
[
"CulturalRegion",
""
],
[
"Dam",
""
],
[
"Delta",
""
],
[
"Desert",
""
],
[
"DrainageBasin",
""
],
[
"Dune",
""
],
[
"FacilityStructure",
""
],
[
"FerryTerminal",
""
],
[
"FinancialStructure",
""
],
[
"FireStation",
""
],
[
"Forest",
""
],
[
"Fort",
""
],
[
"Garden",
""
],
[
"Geyser",
""
],
[
"Glacier",
""
],
[
"GolfCourse",
""
],
[
"GreaterPopulatedPlace",
""
],
[
"HigherEducationFacility",
""
],
[
"HistoricalSite",
""
],
[
"Hospital",
""
],
[
"HotSpring",
""
],
[
"Ice",
""
],
[
"IndigenousPeoplesReserve",
""
],
[
"IndustrialStructure",
""
],
[
"Island",
""
],
[
"Isthmus",
""
],
[
"Lake",
""
],
[
"LandArea",
""
],
[
"Landform",
""
],
[
"LandmarkBuilding",
""
],
[
"Library",
""
],
[
"Lighthouse",
""
],
[
"Marina",
""
],
[
"Market",
""
],
[
"MedicalStructure",
""
],
[
"MetroStation",
""
],
[
"MilitaryBase",
""
],
[
"Mission",
""
],
[
"Monument",
""
],
[
"Mosque",
""
],
[
"Mountain",
""
],
[
"MountainRange",
""
],
[
"MultiModalStation",
""
],
[
"Museum",
""
],
[
"NauticalStructure",
""
],
[
"Neighborhood",
""
],
[
"Oasis",
""
],
[
"ObservationPoint",
""
],
[
"Ocean",
""
],
[
"OfficeBuilding",
""
],
[
"Other",
""
],
[
"Park",
""
],
[
"ParkingStructure",
""
],
[
"Pass",
""
],
[
"Peninsula",
""
],
[
"Plain",
""
],
[
"Planet",
""
],
[
"Plateau",
""
],
[
"Playground",
""
],
[
"PlayingField",
""
],
[
"Pole",
""
],
[
"PoliticalUnit",
""
],
[
"PopulatedPlace",
""
],
[
"Port",
""
],
[
"Postcode1",
""
],
[
"Promontory",
""
],
[
"RaceTrack",
""
],
[
"RailwayStation",
""
],
[
"Reef",
""
],
[
"ReligiousStructure",
""
],
[
"Reserve",
""
],
[
"ResidentialStructure",
""
],
[
"River",
""
],
[
"RoadBlock",
""
],
[
"Ruin",
""
],
[
"ScientificResearchBase",
""
],
[
"Sea",
""
],
[
"SeaplaneLandingArea",
""
],
[
"Shrine",
""
],
[
"SkiArea",
""
],
[
"Spring",
""
],
[
"Stadium",
""
],
[
"StatisticalDistrict",
""
],
[
"Temple",
""
],
[
"Theater",
""
],
[
"TouristRailway",
""
],
[
"TouristStructure",
""
],
[
"Trailhead",
""
],
[
"TransportationStructure",
""
],
[
"Tunnel",
""
],
[
"Valley",
""
],
[
"Volcano",
""
],
[
"Walkway",
""
],
[
"Wall",
""
],
[
"WaterFeature",
""
],
[
"Waterfall",
""
],
[
"Wetland",
""
],
[
"Winery",
""
],
[
"Zoo",
""
]
],
"old": [
[
"Address",
""
],
[
"AdminDivision1",
""
],
[
"AdminDivision2",
""
],
[
"AdminDivision3",
""
],
[
"AdministrativeBuilding",
""
],
[
"Airport",
""
],
[
"AirportTerminal",
""
],
[
"AmusementPark",
""
],
[
"AncientSite",
""
],
[
"Aquarium",
""
],
[
"Archipelago",
""
],
[
"Basin",
""
],
[
"Battlefield",
""
],
[
"Bay",
""
],
[
"Beach",
""
],
[
"Bridge",
""
],
[
"BusinessStructure",
""
],
[
"Camp",
""
],
[
"Canal",
""
],
[
"Casino",
""
],
[
"Castle",
""
],
[
"Cave",
""
],
[
"Cemetery",
""
],
[
"Channel",
""
],
[
"Church",
""
],
[
"Cliff",
""
],
[
"Coast",
""
],
[
"CommunityCenter",
""
],
[
"Continent",
""
],
[
"CountryRegion",
""
],
[
"Crater",
""
],
[
"CulturalRegion",
""
],
[
"Dam",
""
],
[
"Delta",
""
],
[
"Desert",
""
],
[
"DrainageBasin",
""
],
[
"Dune",
""
],
[
"FacilityStructure",
""
],
[
"FerryTerminal",
""
],
[
"FinancialStructure",
""
],
[
"FireStation",
""
],
[
"Forest",
""
],
[
"Fort",
""
],
[
"Garden",
""
],
[
"Geyser",
""
],
[
"Glacier",
""
],
[
"GolfCourse",
""
],
[
"GreaterPopulatedPlace",
""
],
[
"HigherEducationFacility",
""
],
[
"HistoricalSite",
""
],
[
"Hospital",
""
],
[
"HotSpring",
""
],
[
"Ice",
""
],
[
"IndigenousPeoplesReserve",
""
],
[
"IndustrialStructure",
""
],
[
"Island",
""
],
[
"Isthmus",
""
],
[
"Lake",
""
],
[
"LandArea",
""
],
[
"Landform",
""
],
[
"LandmarkBuilding",
""
],
[
"Library",
""
],
[
"Lighthouse",
""
],
[
"Marina",
""
],
[
"Market",
""
],
[
"MedicalStructure",
""
],
[
"MetroStation",
""
],
[
"MilitaryBase",
""
],
[
"Mission",
""
],
[
"Monument",
""
],
[
"Mosque",
""
],
[
"Mountain",
""
],
[
"MountainRange",
""
],
[
"MultiModalStation",
""
],
[
"Museum",
""
],
[
"NauticalStructure",
""
],
[
"Neighborhood",
""
],
[
"Oasis",
""
],
[
"ObservationPoint",
""
],
[
"Ocean",
""
],
[
"OfficeBuilding",
""
],
[
"Other",
""
],
[
"Park",
""
],
[
"ParkingStructure",
""
],
[
"Pass",
""
],
[
"Peninsula",
""
],
[
"Plain",
""
],
[
"Planet",
""
],
[
"Plateau",
""
],
[
"Playground",
""
],
[
"PlayingField",
""
],
[
"Pole",
""
],
[
"PoliticalUnit",
""
],
[
"PopulatedPlace",
""
],
[
"Port",
""
],
[
"Postcode1",
""
],
[
"Promontory",
""
],
[
"RaceTrack",
""
],
[
"RailwayStation",
""
],
[
"Reef",
""
],
[
"ReligiousStructure",
""
],
[
"Reserve",
""
],
[
"ResidentialStructure",
""
],
[
"River",
""
],
[
"RoadBlock",
""
],
[
"RoadIntersection",
""
],
[
"Ruin",
""
],
[
"ScientificResearchBase",
""
],
[
"Sea",
""
],
[
"SeaplaneLandingArea",
""
],
[
"Shrine",
""
],
[
"SkiArea",
""
],
[
"Spring",
""
],
[
"Stadium",
""
],
[
"StatisticalDistrict",
""
],
[
"Temple",
""
],
[
"Theater",
""
],
[
"TouristRailway",
""
],
[
"TouristStructure",
""
],
[
"Trailhead",
""
],
[
"TransportationStructure",
""
],
[
"Tunnel",
""
],
[
"Valley",
""
],
[
"Volcano",
""
],
[
"Walkway",
""
],
[
"Wall",
""
],
[
"WaterFeature",
""
],
[
"Waterfall",
""
],
[
"Wetland",
""
],
[
"Winery",
""
],
[
"Zoo",
""
]
]
}
}
]
}
}
}
}
}
}
⚼ Request
GET:
/geocode:autocomplete
{
x-ms-client-id:
string
,
Accept-Language:
string
,
api-version:
string
,
query:
string
,
coordinates:
array
,
bbox:
array
,
top:
integer
,
resultTypeGroups:
array
,
resultTypes:
array
,
view:
string
,
countryRegion:
string
,
}
⚐ Response (200)
{
$headers:
{
,
x-ms-request-id:
string
,
}
$schema:
}
{
,
type:
enum
,
features:
[
]
,
{
,
type:
enum
,
geometry:
object
,
properties:
}
{
,
typeGroup:
enum
,
type:
enum
,
address:
{
,
addressLine:
string
,
locality:
string
,
neighborhood:
string
,
adminDistricts:
[
]
,
{
,
name:
string
,
shortName:
string
,
}
postalCode:
string
,
countryRegion:
{
,
ISO:
string
,
name:
string
,
}
formattedAddress:
string
,
streetName:
string
,
streetNumber:
string
,
intersection:
}
{
,
baseStreet:
string
,
secondaryStreet1:
string
,
secondaryStreet2:
string
,
intersectionType:
string
,
displayName:
string
,
}
name:
string
,
}
nextLink:
string
,
}
⚐ Response (default)
{
error:
}
{
,
code:
string
,
message:
string
,
target:
string
,
details:
[
,
string
,
]
additionalInfo:
}
[
]
,
{
,
type:
string
,
info:
object
,
}